Range

Function

This API is used to get Alarm > IP Speaker Parameter range.

Request message

Parameter description

Table 1
ParameterRangeTypeDescription
speaker"SP1"…"SPx"
Device Supported Speaker device.
string

Request 1 Example:

POST /API/AlarmConfig/IpSpeakerOnvif/Range HTTP/1.1
{
    "version":"1.0",
	"data": {
		"speaker": "SP1"
	}
}

Request 2 Example:

POST /API/AlarmConfig/IpSpeakerOnvif/Range HTTP/1.1
{
    "version":"1.0",
	"data": {}
}

Response message

Parameter description

Table 2
ParameterRangeTypeDescription
ip_speaker_infoJson ArrayDevice information see Table 3
Table 3
ParameterRangeTypeDescription
numberJson intSerial number
enableJson boolWhether to enable
nameJson stringDevice name
ip_addressJson stringDevice login address
portJson intDevice login port
status"Offline","UnAuther","Online"stringStatus.
user_nameJson stringUser name for logging in to the device
passwordJson stringPassword for logging in to the device
password_emptyJson boolWhether the password of the device login user is empty
binding_channel"SP1"…"SPx"string arrayBound channel.

Response 1 Example:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "name": {
            "type": "string",
            "min_len": 0,
            "max_len": 31
        }
    }
}

Response 2 Example:

HTTP/1.1 200 OK
Content-Type: application/json
{
    "result": "success",
    "data": {
        "ip_speaker_info": {
            "type": "array",
            "min_size": 0,
            "max_size": 16,
            "items": [
                {
                    "number": {
                        "type": "int32",
                        "min": 0,
                        "max": 15
                    },
                    "enable": {
                        "type": "bool"
                    },
                    "name": {
                        "type": "string",
                        "min_len": 0,
                        "max_len": 31
                    },
                    "ip_address": {
                        "type": "string",
                        "min_len": 0,
                        "max_len": 63
                    },
                    "port": {
                        "type": "int32",
                        "min": 1,
                        "max": 65535
                    },
                    "status": {
                        "type": "string",
                        "items": [
                            "Offline",
                            "UnAuther",
                            "Online"
                        ]
                    },
                    "user_name": {
                        "type": "string",
                        "min_len": 0,
                        "max_len": 35
                    },
                    "password": {
                        "type": "string",
                        "min_len": 0,
                        "max_len": 35
                    },
                    "password_empty": {
                        "type": "bool"
                    },
                    "binding_channel": {
                        "type": "array",
                        "min_size": 0,
                        "max_size": 16,
                        "items": {
                            "type": "string",
                            "items": [
                                "CH1",
                                "CH2",
                                "CH3",
                                "CH4",
                                "CH5",
                                "CH6",
                                "CH7",
                                "CH8",
                                "CH9",
                                "CH10",
                                "CH11",
                                "CH12",
                                "CH13",
                                "CH14",
                                "CH15",
                                "CH16"
                            ]
                        }
                    }
                }
            ]
        }
    }
}

Error Code

See Response Messages Body and Common error_code for more information.